home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / comm / cnet / trek_quotes.lha / TrekQuotes2.README! < prev    next >
Text File  |  1995-10-08  |  9KB  |  208 lines
  1. ============================================================================
  2.         Trek Quotes, v2.2 README! File by Dotoran of Frontiers!
  3. ============================================================================
  4.  
  5. What Is It?
  6. ~~~~~~~~~~~
  7.     This is one of those QUOTE programs you can add to your BBS. This one
  8. contains 130 Quotes from Star Trek, The Original Series.
  9.  
  10.     This 2.x versions were written by myself as an update to the original
  11. version 1.0 by Dan, SysOp of Liesure World BBS, using the Random Quote
  12. Generator routine, written by Jim Selleck of Beverly James Products.
  13.  
  14.     The first version of this program was lacking in TWO major areas:
  15.  
  16. 1: There were absoulutely NO GRAPHICS to speak of. It simply displayed the
  17.    random quote.
  18.  
  19. 2: It was EXTREMELY slow in LOCATING, LOADING & DISPLAYING the quote.
  20.  
  21.     This version, MY Version, has successfully combatted both of the above
  22. noted problems, as well as offering the SysOp a multitude of ways in which
  23. this program can be utilized.
  24.  
  25. How Do I Install It?
  26. ~~~~~~~~~~~~~~~~~~~~
  27.     There are at LEAST Four ways I can think of to add this Quote Program
  28. into your bulletin board systems. Please choose the place that interests
  29. you most, or perhaps you'll think of an even BETTER place to put it:
  30.  
  31. For all of the possible utilizations of this program, it will be necessary
  32. for you to copy the "TrekQuotes2" files(all 3 of them) into your PFILES:
  33. section, THEN choose one or more of the following installations...
  34.  
  35. 1: Place it INSIDE your "sys.welcome" file(in your SysText: Directory) by
  36.    adding the following command line:
  37.  
  38.             {#0pfiles:TrekQuotes2}
  39.             ^
  40.         Control-Q
  41.  
  42. 2: Place it in either your GFILES or PFILES library as a Multi-Use Arexx
  43.    PFile, with the MORE? Prompt disabled!
  44.  
  45. 3: Include it within your "sys.end" file(in SysText:), or within the entry,
  46.    or exit file for a Star Trek Message Base/UD Base(Use EN or X to edit
  47.    these files from WITHIN the base), by adding this command line:
  48.  
  49.             {#0pfiles:TrekQuotes2}
  50.             ^
  51.         Control-Q
  52.  
  53. 4: Create a "TREK" command in your "bbsmenu" file(in CNET:) that can be
  54.    used by anybody. Do this by adding the following line to the end of
  55.    Menu # 2, Available Everywhere:
  56.  
  57.         TREK, TREK quotes   `1- |   {#0pfiles:TrekQuotes2}
  58.                              ^      ^
  59.                  Access Groups      Control-Q
  60.  
  61. As you can see, LOGON isn't the ONLY place this file COULD be used. Pick
  62. the place that best suits your needs, and stick it there!
  63.  
  64. It is now ready to be used in your system, although there ARE (as usual),
  65. some variables you may wish to edit near the beginning of the "TrekQuotes2"
  66. Arexx Command file that will let you select colors & other neat stuff!
  67.  
  68. How Do I Customize It For My System?       - or -
  69. Are There Any SysOp Definable Variables?
  70. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71.     Hey, this is DOTORAN your reading from. Of COURSE there is! Hehe...
  72.  
  73. Loading "TrekQuotes2" into your favorite text editor, edit the following
  74. variables which you will find near the beginning of this listing:
  75.  
  76. The "color" variables below all use the MCI Color Character for their
  77. contents. Recall, these are the: 0,1,2,3,4,5,6,7,8,9,a,b,c,d,e, and f:
  78.  
  79.     c1 ---> The actual Trek Quote will be displayed in THIS color.
  80.     c2 ---> The Quotes Author(Kirk, McCoy, etc.) will be THIS color.
  81.  
  82. The following 10 variables allow you to change the appearance of the planet
  83. the Enterprise is orbiting above. (Pretty NEAT, I thought!)
  84.  
  85.    c.1 ---> Color of the LEFT  Moon, below the Quote.
  86.    c.2 ---> Color of the RIGHT Moon, below the Quote.
  87.    c.3 ---> Color of the SMALL STARS, to the LEFT  of the Planet.
  88.    c.4 ---> Color of the SMALL STARS, to the RIGHT of the Planet.
  89.    c.5 ---> Color of the LARGE STARS, to the LEFT  of the Planet.
  90.    c.6 ---> Color of the LARGE STARS, to the RIGHT of the Planet.
  91.    c.7 ---> Color of the WATER (Largest Area) ON the Planet.
  92.    c.8 ---> Color of the NORTH POLE (Ice Cap) ON the Planet.
  93.    c.9 ---> Color of the LEFT  Continent ON the Planet.
  94.   c.10 ---> Color of the RIGHT Continent ON the Planet.
  95.  
  96. NOTE: The "water" variable above, "c.7" has a limitation in that you may
  97.       ONLY use the values: 0, 1, 2, 3, 4, 5, 6, and 7. Values HIGHER than
  98.       7 will result in the Planet Graphic looking rather strange!
  99.  
  100.   rand ---> Use RANDOM Colors every time a Quote is Displayed? (0=No,1=Yes)
  101.             I highly suggest using "1", as it will give the appearance that
  102.             the Enterprise is orbiting different NEW WORLDS (where no man
  103.             has gone before!)
  104.  
  105.  delay ---> This is for a step down counter which is used AFTER a Quote is
  106.             shown to the user. The value should be between 0 (No Wait) and
  107.             9 (Long Wait). This is used for an MCI \W command. If you'll be
  108.             using this program through another program, like my LogActs,
  109.             that would give a pause bar(press any key), then you may wish
  110.             to leave this variable set to "0" for NO WAIT.
  111.  
  112. The last three variables will only need to be edited if you choose to change
  113. or add quotes to "TrekQuotes2", and will be discussed fully below. If you
  114. are satisfied the 130 initial quotes are enough, then you needn't read the
  115. next section, or continue to modify the program further.
  116.  
  117. How Are The Quotes Saved & How Do I Edit(or Add) To Them?
  118. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  119.     As is, this program contains 130 ready-to-go quotes, but if you find the
  120. need to MODIFY or ADD to these quotes, here's how:
  121.  
  122.     The two support files, "TrekQuotes2.txt" and "TrekQuotes2.dat" are used
  123. to store the actual quotes. The ".dat" file is a packed character file, and
  124. can NOT be edited through a text editor, although it IS possible to edit it
  125. using a HEX editor. The command file only uses the ".dat" file, and will NOT
  126. need to use the ".txt" file at ALL, unless you wish to modify the quotes.
  127.  
  128.     The ".txt" file is a standard text file capable of being loaded into any
  129. text editor you choose. The format of this file is as follows:
  130.  
  131. 1: ONE Quote PER Line, with NO Skipped Lines.
  132.  
  133. 2: Separate Lines WITHIN the SAME Quote are connected with the | character,
  134.    which can be got by pressing SHIFT \ (to the right of the = sign).
  135.  
  136. 3: Each Quote should be NO LONGER than FIVE Lines(INCLUDING the Author Line).
  137.  
  138. 4: The Author Line should appear on a line of it's own, and follow this
  139.    format:
  140.             -Who Said It "Episode Title"(if known)
  141.  
  142. So, following the above rules, here's how the following quote would be
  143. constructed:
  144.  
  145.                     "Jim! Jim, your alive!"
  146.                       -Spock "Amok Time"
  147.  
  148. "Jim! Jim, your alive!"|-Spock "Amok Time"
  149.  
  150. No special characters need to be added to the END of the above line. This
  151. will be taken care of shortly.
  152.  
  153. If you choose to ADD (or DELETE) Quotes from the List, you will need to edit
  154. the "total" variable near the beginning of the "TrekQuotes2" Command File:
  155.  
  156.  total ---> The TOTAL Number of Trek Quotes On File. (in the ".dat" file)
  157.  
  158. Also, keep an eye on the LENGTH of each constructed line you add(or edit):
  159.  
  160. "Jim! Jim, your alive!"|-Spock "Amok Time"
  161.          1         2         3         4
  162. 123456789012345678901234567890123456789012345
  163.  
  164. In our above example, the LENGTH of the new constructed line is 42 chars
  165. long. The longest string included with the 130 initial quotes was around
  166. 147 characters. If you edit or add a quote and it's length exceeds 150
  167. characters, then you will need to edit the "size" variable found in the
  168. "TrekQuotes2" Arexx Command file:
  169.  
  170.   size ---> Length of the LONGEST Quote String. I rounded it UP to the next
  171.             "10" for ease in calculations, so 147 rounded UP to 150.
  172.  
  173. When you are finished modifying the ".txt" file, you will need to RePack it
  174. into the ".dat" format. To do this, edit the "build" variable:
  175.  
  176.  build ---> Set at "0" and the program runs normally.
  177.             Set at "1" and the program acts as a PACKER to RePack the
  178.             "TrekQuotes2.txt" file into the "TrekQuotes2.dat" file.
  179.  
  180. Once set to "1", run the "TrekQuotes2" file once to RePack the quote file,
  181. then edit the "build" variable back to "0" to enable quote displays using
  182. the newly updated file.
  183.  
  184. That's It, Nothing Else!
  185. ~~~~~~~~~~~~~~~~~~~~~~~~
  186.     That's all there is to this file. I'd like to make the following
  187. acknowledgements, however:
  188.  
  189.     Gene Roddenberry - For creating the Star Trek universe that has served
  190.                        as my second vice, next to Arexx.
  191.  
  192.     Jim Selleck - For coming up with the Quote Program Generator idea.
  193.                   (You'll see what I mean soon)
  194.  
  195.     Dan (Liesure World) - For originally getting together all the Quotes.
  196.  
  197.     Unknown Artist - For drawing an ASCII version USS Enterprise that I used
  198.                      to create the ANSI equivalent.
  199.  
  200.     CNet Amiga SysOps - Who have read my README! files diligently! hehe
  201.  
  202.     If you have any problems running this program, or have an idea for a
  203. future enhancement to this program, please let me know!
  204.  
  205. ============================================================================
  206.     Coding Written Entirely by Dotoran of Frontiers BBS (716)/823-9892!
  207. ============================================================================
  208.